home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dirut / dirm13.zip / DIRM13.DOC < prev    next >
Text File  |  1990-11-02  |  9KB  |  200 lines
  1.  
  2.                       DIRM v1.3  FAST! Directory Lister
  3.                       ---------------------------------
  4.  
  5.                                 Documentation
  6.                               November  2, 1990
  7.  
  8.  
  9. This is meant to be a replacement for DOS's DIR command.  If you are like
  10. me you do many DIRs a day and wait and wait while they scroll by.  Many times
  11. I only want to see how much space is left on the drive, but seeing the whole
  12. directory gives me confidence that I am in the right place.  The answer is a
  13. fast directory lister which gives the same info as DIR but is faster.  While
  14. doing this, I added a couple of extra features that will be helpful at times.
  15.  
  16. Usage: dirm [d:][file specification] [/switches]
  17.  
  18. Just like DIR, typing DIRM alone will display the current directory.
  19. You'll be quite happy when you see the speed, even though the program
  20. will have to load itself first from somewhere in your PATH.  Putting DIRM
  21. in the directory listed first in your path, will help some too.  The program
  22. is very small, written completely in assembly language, so loading time is
  23. negligible.
  24.  
  25. You'll also notice that the file specification you chose is shown,
  26. so you are sure you have the right one.  A byte count of matching files
  27. is also given, along with the number of files (directories, hidden and
  28. system files excluded from this count) and bytes free on the disk.
  29.  
  30. Supported switches are as follows:
  31.  
  32. /a      This allows the attributes of the file to be displayed after the
  33.         time stamp.  Five attributes are displayed as follows:
  34.  
  35.         Column 1: Read-only Attribute.  An R indicates that the file
  36.                   is read only.
  37.  
  38.         Column 2: Hidden Attribute. An H indicates the file is hidden and
  39.                   will not be displayed unless the /a switch is active.
  40.  
  41.         Column 3: System File Attribute.  An S indicates the file is a
  42.                   system file.
  43.  
  44.         Column 4: Directory Attribute.  A D indicates the entry is not a
  45.                   file, but a subdirectory name.
  46.  
  47.         Column 5: Archive Attribute. An A indicates the archive attribute
  48.                   for this file is turned on.
  49.  
  50.         A '.' in any of these columns means that attribute is not active.
  51.  
  52.  
  53. /p      This is similar to the DIR /p switch.  It will stop after displaying
  54.         one screen and wait for a key press.  Unlike the DIR /p switch this
  55.         switch will leave the Volume/Directory header on the screen. It also
  56.         erases the 'Press any key...' message before going to the next screen,
  57.         so only file names are left on the screen when the directory listing is
  58.         complete.  You'll need this one, since this program is FAST!
  59.  
  60.  
  61. /w      This is similar to the DIR /w switch.  It will print in 5 files
  62.         a line mode with only file names.  Since the file sizes are not
  63.         shown on the screen, there is no calculation of bytes in the
  64.         displayed files.  The number of files and bytes free is still printed
  65.         as normal.
  66.  
  67.  
  68. Compatibility of switches:
  69.  
  70.         Since attributes cannot be printed in wide mode, the function
  71.         of using /a /w together allows all types of files to be printed
  72.         in wide mode including hidden and system files, although you will not
  73.         be able to differentiate between the file's attributes.
  74.  
  75.         /a /p will work as expected printing attributes and waiting at the
  76.         end of each page.
  77.  
  78.         /w /p will work as expected printing in wide mode and waiting at the
  79.         end of each page.
  80.  
  81.         A combination of all three also works, with the qualification
  82.         described above for the /a /w switches.
  83.  
  84.  
  85. Filters and Redirection:
  86.  
  87.         Because of the FAST! screen writes that make DIRM what it is,
  88.         filters such as SORT and MORE, and redirection < and > are not
  89.         supported.  This isn't a great loss since: a) MORE is available
  90.  
  91.         with the /p switch. b) SORTing is rarely done in directories since
  92.         non-permanent directory sorts are a waste of time.  Permanent
  93.         sorting can be done easily with utilities such as PC Tools. c)
  94.         Redirection of a directory to a file or printer is always available
  95.         with DIR, since DIR is more than fast enough for these functions.
  96.  
  97.         If you try using filters and redirection with DIRM, you will
  98.         definitely not get what you expect, but it shouldn't cause any
  99.         harm.
  100.  
  101.  
  102. Source code:
  103.  
  104.         I am including the full source code for this program.  This is the
  105.         first real program I have created in all assembly fashion so the code
  106.         may look messy to experienced assembly programmers.  It is all well
  107.         commented so those who want to modify it for their own purposes may
  108.         do so, with a MASM compatible assembler.  Please don't change the
  109.         copyright info and programmer's signature and recompile it trying to
  110.         pass it off as your own work.  I still retain the copyright on the
  111.         program.  PLEASE do not alter this code for commercial use without
  112.         consent from me, the programmer.
  113.  
  114.  
  115. Bugs:
  116.  
  117.         Before I first released DIRM v1.0 I had been actively using it for
  118.         3 months and didn't find anything I considered a bug.  Since then
  119.         we have found a few real bugs.  I do my best to fix these as soon
  120.         as possible.  A few people have suggested improvements that would make
  121.         DIRM more like DOS's DIR. Since old habits are hard to break, I will
  122.         continue to incorporate these in future releases, to a point.  So
  123.         PLEASE contact me with your suggestions.  I really appreciate the
  124.         feedback.  Better yet, since you will have the source, fix the bug and
  125.         send me the listing of your modifications.  If I decide it works well,
  126.         fits in with the purpose and goal of DIRM, and is relatively clean
  127.         code I will give you credit and my thanks!
  128.  
  129.  
  130. Contribution:
  131.  
  132.         If you use this program often it will save you quite a bit of money.
  133.         How you ask?  Well how many times a day do you display a directory?
  134.         I probably do a minimum of 20 a day... Let's say each DIRM display
  135.         saves 1 second over the DIR display.  Over 1 year (365 days) that is
  136.         7,300 seconds saved, or 121 2/3 minutes saved, or 2 hours saved.  Even
  137.         if your time is worth sub-minimum wage of $3.75 you would be saving
  138.         $7.50.  So why not send me $1, $2, $3, $4, $5, or whatever you think
  139.         the time saved is worth.  Even if you decide to keep using the program
  140.         without any contribution let me know you enjoy the program, send me
  141.         a funny joke or story, blank floppy disks, or anything else a strugg-
  142.         ling computer engineering student might find of some value.  Even a
  143.         discussion of my above statistics would be welcome!
  144.  
  145.  
  146. Liability, Compatibility and Distribution Rights:
  147.  
  148.         This program is offered on an AS IS basis with no warranties
  149.         expressed or implied.  I assume no responsibility for any damage
  150.         to your machine or loss of data incurred while using this program.
  151.         It is very unlikely that unaltered DIRM could cause any damage.
  152.         Since this program was not tested on every machine, I cannot
  153.         guarantee it will work on yours.  It should run on all MS-DOS machines
  154.         running DOS version 2.0 and higher.  If this turns out not to be the
  155.         case let me know.
  156.  
  157.         This set of files may be distributed freely as long as it is not
  158.         changed or altered and contains all the original files listed below.
  159.         It may not be sold without the written consent of the author.
  160.  
  161.  
  162. Version Information:
  163.  
  164.         o Version 1.0 (6-20-90) was the original release.
  165.  
  166.         o Version 1.1 (9-09-90) fixed DIRM so it acted more like
  167.           DOS's DIR in that it treats FILESPEC and FILESPEC.* as equivalent.
  168.           Thanks to Alex Stone for being the first to point this out.
  169.  
  170.         o Version 1.2 (9-14-90) DIRM will now treat DIRM .EXE as DIRM *.EXE
  171.           like DOS's DIR.  The driv